docs: tidying; update version refs; describe various catalogues #1616
Conversation
|
Thanks @atcol for giving the docs some much needed TLC ❤️ |
|
Thank you @Fokko - I have a little more to do to spice it up but I noticed it was a "low hanging fruit" to help improve things and helps me learn the repo a bit more as I hope to contribute. |
|
I think this initial PR is ready for review. There's room for more improvement but I might trickle that in. Worth double checking my understanding of the implementation status for the catalogues! |
|
@atcol sure that makes sense, there is one issue: |
|
Woops! Fixed! Thanks :) |
There was a problem hiding this comment.
Thanks @atcol for this pr, generally looks good. Just left some comments
website/src/introduction.md
Outdated
| Rather than being a new file type, Iceberg provides a metadata layer that sits on top of formats like Parquet | ||
| and ORC, ensuring data is organized, accessible, and safe to work with at scale. It introduces features long | ||
| expected in databases such as transactional consistency, schema evolution, and time travel into environments | ||
| where files are stored directly on systems like Amazon S3 or HDFS. | ||
|
|
||
| Originally developed at Netflix, it was designed as a response to the limitations of early Hive tables, which were | ||
| essentially directories of files with only loose conventions for schema and partitioning. While this approach | ||
| enabled cheap storage of large datasets, it struggled with schema changes, concurrent writes, and efficient query | ||
| planning. |
There was a problem hiding this comment.
How about removing this part ? These are copied from official website.
There was a problem hiding this comment.
They aren't copied from the original website -- they're something I wrote. I am happy to remove if you'd prefer, but I was going to later add more to this and other introductory material to give a narrative to the library plus some diagrams.
There was a problem hiding this comment.
The new statement looks more concise, thanks for the fix!
Thanks! I've committed the rewords for the catalogues and a better link. One final comment regarding the intro section for Iceberg. |
Co-authored-by: Renjie Liu <[email protected]>
Co-authored-by: Renjie Liu <[email protected]>
Co-authored-by: Renjie Liu <[email protected]>
…he#1616) ## Which issue does this PR close? No issue. I thought I'd improve the docs a bit. ## What changes are included in this PR? Only changes to the website (mdbook). ## Are these changes tested? Yes all pages render correctly. --------- Co-authored-by: Alex <atc@localhost> Co-authored-by: Renjie Liu <[email protected]>
Which issue does this PR close?
No issue. I thought I'd improve the docs a bit.
What changes are included in this PR?
Only changes to the website (mdbook).
Are these changes tested?
Yes all pages render correctly.